fix: Inconsistent use of v3 and v4 Weaviate clients #13719
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
All references to Weaviate V3 clients (weaviate.Client) have been changed to Weaviate V4 clients (weaviate.WeaviateClient). Documentation has also been modified to reflect changes. Additionally, the `auth_config` argument to `WeaviateVectorStore.from_params` has been made optional to match the underlying `weaviate.WeaviateClient` signature.
dosubot
bot
added
the
size:S
chrisk314
changed the title
chrisk314
changed the title
dosubot
bot
added
size:M
|
Requires review of existing documentation related to Weaviate integration and potential modification of examples to use V4 Weaviate clients. |
|
Is this PR planned to be merged ? It has been five months. |
dosubot
bot
added
size:S
| if not isinstance(client, weaviate.WeaviateClient): | ||
| raise ValueError( | ||
| f"Invalid client type, expected weaviate.WeaviateClient, got {type(client)}" | ||
| ) |
There was a problem hiding this comment.
This PR is slightly out of date -- you can technically pass in an async client or sync client these days. This would break that
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR addresses #13614 which relates to inconsistencies between Weaviate V3 and V4 clients in the
llama-index-vector-stores-weaviateimplementation. This causes bugs due to breaking API changes between V3 and V4.All references to Weaviate V3 clients (
weaviate.Client) have been changed to Weaviate V4 clients (weaviate.WeaviateClient). The current implementation expects Weaviate V4 clients. Documentation has also been modified to reflect changes.Additionally, the
auth_configargument toWeaviateVectorStore.from_paramshas been made optional to match the underlyingweaviate.WeaviateClientsignature.Fixes #13614
Version Bump?
Did I bump the version in the
pyproject.tomlfile of the package I am updating? (Except for thellama-index-corepackage)Type of Change
Please delete options that are not relevant.
How Has This Been Tested?
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration
I manually tested the code against a locally running Weaviate database instance. Specifically, I have run the updated example code in the
WeaviateVectorStoredocstring (changing the Weaviate url as required); and I have manually tested the modifiedWeaviateVectorStore.from_paramsmethod with the same url. Due to the fact that adequately testing the code requires Weaviate infrastructure to test against, and no pattern is currently in place for such integration tests, I have not attempted to add such integration tests in this set of changes.Suggested Checklist:
make format; make lintto appease the lint gods